/*
 * Iparelan Annotations Utilities
 * This file is part of Pattern Notes.
 * Copyright (c) 2008, Iparelan Solutions, LLC. All rights reserved.
 *
 * Pattern Notes is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Pattern Notes is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Pattern Notes. If not, see <http://www.gnu.org/licenses/>.
 */

package com.iparelan.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Declares that the compiler has been know to generate sythetic code near the
 * marked point. For example, a synthetic method may be generated to access
 * private data of an enclosing class. Such synthetic methods could pose a
 * security risk and usually have names like {@code access$000}.
 *
 * @author Greg Mattes
 * @version July 2008
 *
 * @see <nobr><a href="http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html#80128">"The Java Virtual Machine Specification Second Edition," Lindholm and Yellin, Section 4.7.6, "The Sythentic Attribute."</a></nobr>
 * @see <nobr><a href="http://pmd.sourceforge.net/rules/design.html#AccessorClassGeneration">PMD's {@code AccessorClassGeneration} rule</a></nobr>
 */
@Retention(RetentionPolicy.SOURCE)
@Copyright("Copyright &copy; 2008, Iparelan Solutions, LLC. All rights reserved.")
public @interface SyntheticCodeGeneration {
}
